/*!	 xorpattern.cpp
**	 Implementation of the "XOR Pattern" layer
**
**	Copyright (c) 2002-2005 Robert B. Quattlebaum Jr., Adrian Bentley
**	Copyright (c) 2007-2008 Chris Moore
**	Copyright (c) 2011-2013 Carlos López
**
**	This package is free software; you can redistribute it and/or
**	modify it under the terms of the GNU General Public License as
**	published by the Free Software Foundation; either version 2 of
**	the License, or (at your option) any later version.
**
**	This package is distributed in the hope that it will be useful,
**	but WITHOUT ANY WARRANTY; without even the implied warranty of
**	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
**	General Public License for more details.
**
** === N O T E S ===========================================================
**
** ========================================================================= */

#ifdef USING_PCH
#	include "pch.h"
#else
#ifdef HAVE_CONFIG_H
#	include <config.h>
#endif

#include "xorpattern.h"

#include <synfig/localization.h>
#include <synfig/general.h>

#include <synfig/string.h>
#include <synfig/time.h>
#include <synfig/context.h>
#include <synfig/paramdesc.h>
#include <synfig/renddesc.h>
#include <synfig/surface.h>
#include <synfig/value.h>
#include <synfig/valuenode.h>

#endif

using namespace std;
using namespace etl;
using namespace synfig;
using namespace modules;
using namespace lyr_std;

SYNFIG_LAYER_INIT(XORPattern);
SYNFIG_LAYER_SET_NAME(XORPattern, "xor_pattern");
SYNFIG_LAYER_SET_LOCAL_NAME(XORPattern, N_("XOR Pattern"));
SYNFIG_LAYER_SET_CATEGORY(XORPattern, N_("Other"));
SYNFIG_LAYER_SET_VERSION(XORPattern, "0.1");
SYNFIG_LAYER_SET_CVS_ID(XORPattern, "$Id$");

XORPattern::XORPattern():
    Layer_Composite(1.0, Color::BLEND_COMPOSITE),
    param_origin(ValueBase(Vector(0.125, 0.125))),
    param_size(ValueBase(Vector(0.25, 0.25)))
{
    SET_INTERPOLATION_DEFAULTS();
    SET_STATIC_DEFAULTS();
}

bool
XORPattern::set_param(const String & param, const ValueBase &value)
{
    IMPORT_VALUE(param_origin);
    IMPORT_VALUE(param_size);

    if (param == "pos") {
        return set_param("origin", value);
    }

    return Layer_Composite::set_param(param, value);
}

ValueBase
XORPattern::get_param(const String & param)const
{
    EXPORT_VALUE(param_origin);
    EXPORT_VALUE(param_size);

    EXPORT_NAME();
    EXPORT_VERSION();

    return Layer_Composite::get_param(param);
}

Color
XORPattern::get_color(Context context, const Point &point)const
{
    Point origin = param_origin.get(Point());
    Point size = param_size.get(Point());

    if (get_amount() == 0.0) {
        return context.get_color(point);
    }

    unsigned int a = (unsigned int)floor((point[0] - origin[0]) / size[0]), b = (unsigned int)floor((point[1] - origin[1]) / size[1]);
    unsigned char rindex = (a ^ b);
    unsigned char gindex = (a ^ (~b)) * 4;
    unsigned char bindex = ~(a ^ b) * 2;

    Color color((Color::value_type)rindex / (Color::value_type)255.0,
                (Color::value_type)gindex / (Color::value_type)255.0,
                (Color::value_type)bindex / (Color::value_type)255.0,
                1.0);

    if (get_amount() == 1 && get_blend_method() == Color::BLEND_STRAIGHT) {
        return color;
    } else {
        return Color::blend(color, context.get_color(point), get_amount(), get_blend_method());
    }

}

Layer::Vocab
XORPattern::get_param_vocab()const
{
    Layer::Vocab ret(Layer_Composite::get_param_vocab());

    ret.push_back(ParamDesc("origin")
                  .set_local_name(_("Origin"))
                  .set_description(_("Center of the pattern"))
                 );
    ret.push_back(ParamDesc("size")
                  .set_local_name(_("Size"))
                  .set_description(_("Size of the pattern"))
                  .set_origin("origin")
                 );

    return ret;
}

Layer::Handle
XORPattern::hit_check(Context context, const Point &getpos)const
{
    // if we have a zero amount
    if (get_amount() == 0.0)
        // then the click passes down to our context
    {
        return context.hit_check(getpos);
    }

    Layer::Handle tmp;

    // if we are behind the context, and the click hits something in the context
    if (get_blend_method() == Color::BLEND_BEHIND && (tmp = context.hit_check(getpos)))
        // then return the thing it hit in the context
    {
        return tmp;
    }

    // if we're using an 'onto' blend method and the click missed the context
    if (Color::is_onto(get_blend_method()) && !(tmp = context.hit_check(getpos)))
        // then it misses everything
    {
        return 0;
    }

    // otherwise the click hit us, since we're the size of the whole plane
    return const_cast<XORPattern*>(this);
}